#!/usr/bin/python
#
# Copyright (c) 2008, Mathias Weber
# Copyright (c) 2008, Thomas Stauffer
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
#   list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# $Id: example-epydoc.py 82 2008-10-12 22:28:21Z tymayos $

"""
My module myModule generic description.
"""

"""
Let epydoc generate documentation with:

epydoc.py example-epydoc.py

If epydoc is not in your path try to start it with:

C:\Python25\Scripts\epydoc.py -v example-epydoc.py

"""

import random
import sys

myVariable = 1
"""
My variable myVariable description.
"""

def myFunction():
    """
    My function myFunction description. My more descriptive description.
    """
    if random.random() < 0.5:
        pass

class myClass:
    """
    My class myClass description.
    """
    def myMethod(self, a, b):
        """
        My method myMethod Description.

        @todo: My todo tag description.
        @bug: My bug 1 tag description.
        @bug: My bug 2 tag description.
        @bug: My bug 3 tag description.

        @param a: My parameter a description.
        @param b: My parameter b description.
        @return: Result.
        """
        pass

class myClassChild(myClass):
    """My class myClassChild description."""
    pass
